Keycloak REST Services 1.5.0-Final

Path: / admin / realms / {realm} / user-federation / instances / {id}

get a provider

Path parameters:
realm - realm name (not id!)
id -

Sub-Resources
Resources
NameDescription
mapper-typesList of available User Federation mapper types
mappersGet mappers configured for this provider
synctrigger sync of users

Resource Methods
Method Summary
NameDescription
PUT /admin/realms/{realm}/user-federation/instances/{id}Update a provider
GET /admin/realms/{realm}/user-federation/instances/{id}get a provider
DELETE /admin/realms/{realm}/user-federation/instances/{id}Delete a provider

Method Detail

PUT /admin/realms/{realm}/user-federation/instances/{id}

Update a provider

HTTP Example:
PUT /admin/realms/{realm}/user-federation/instances/{id}
API Example:

UserFederationProviderResource.updateProviderInstance({'realm': /* name realm name (not id!) */,
  'id': …,
  '$entity': /* rep */});

Input:
UserFederationProviderRepresentation
Output:
void
Consumes:
application/json

GET /admin/realms/{realm}/user-federation/instances/{id}

get a provider

HTTP Example:
GET /admin/realms/{realm}/user-federation/instances/{id}
API Example:

UserFederationProviderResource.getProviderInstance({'realm': /* name realm name (not id!) */,
  'id': …});

Output:
UserFederationProviderRepresentation
Produces:
application/json

DELETE /admin/realms/{realm}/user-federation/instances/{id}

Delete a provider

HTTP Example:
DELETE /admin/realms/{realm}/user-federation/instances/{id}
API Example:

UserFederationProviderResource.deleteProviderInstance({'realm': /* name realm name (not id!) */,
  'id': …});

Output:
void

Keycloak REST Services 1.5.0-Final